<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AtkHypertext</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="ATK - Accessibility Toolkit">
<link rel="up" href="atk.html" title="ATK Library">
<link rel="prev" href="atk-AtkHyperlinkImpl.html" title="AtkHyperlinkImpl">
<link rel="next" href="AtkImage.html" title="AtkImage">
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="atk.html" title="ATK Library">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in ATK 1.3">
<link rel="index" href="ix04.html" title="Index of new symbols in ATK 1.4">
<link rel="index" href="ix05.html" title="Index of new symbols in ATK 1.6">
<link rel="index" href="ix06.html" title="Index of new symbols in ATK 1.9">
<link rel="index" href="ix07.html" title="Index of new symbols in ATK 1.12">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="atk-AtkHyperlinkImpl.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="atk.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">ATK - Accessibility Toolkit</th>
<td><a accesskey="n" href="AtkImage.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#AtkHypertext.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#AtkHypertext.description" class="shortcut">Description</a>
                   | 
                  <a href="#AtkHypertext.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#AtkHypertext.implementations" class="shortcut">Known Implementations</a>
                   | 
                  <a href="#AtkHypertext.signals" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="AtkHypertext"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="AtkHypertext.top_of_page"></a>AtkHypertext</span></h2>
<p>AtkHypertext — The ATK interface which provides standard mechanism for manipulating hyperlinks.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="AtkHypertext.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
                    <a class="link" href="AtkHypertext.html#AtkHypertext-struct" title="AtkHypertext">AtkHypertext</a>;
<a class="link" href="AtkHyperlink.html" title="AtkHyperlink">AtkHyperlink</a>*       <a class="link" href="AtkHypertext.html#atk-hypertext-get-link" title="atk_hypertext_get_link ()">atk_hypertext_get_link</a>              (<a class="link" href="AtkHypertext.html" title="AtkHypertext">AtkHypertext</a> *hypertext,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> link_index);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a>                <a class="link" href="AtkHypertext.html#atk-hypertext-get-n-links" title="atk_hypertext_get_n_links ()">atk_hypertext_get_n_links</a>           (<a class="link" href="AtkHypertext.html" title="AtkHypertext">AtkHypertext</a> *hypertext);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a>                <a class="link" href="AtkHypertext.html#atk-hypertext-get-link-index" title="atk_hypertext_get_link_index ()">atk_hypertext_get_link_index</a>        (<a class="link" href="AtkHypertext.html" title="AtkHypertext">AtkHypertext</a> *hypertext,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> char_index);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="AtkHypertext.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GInterface
   +----AtkHypertext
</pre>
</div>
<div class="refsect1" lang="en">
<a name="AtkHypertext.implementations"></a><h2>Known Implementations</h2>
<p>
AtkHypertext is implemented by
 <a class="link" href="AtkNoOpObject.html" title="AtkNoOpObject">AtkNoOpObject</a>.</p>
</div>
<div class="refsect1" lang="en">
<a name="AtkHypertext.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="AtkHypertext.html#AtkHypertext-link-selected" title='The "link-selected" signal'>link-selected</a>"                                  : Run Last
</pre>
</div>
<div class="refsect1" lang="en">
<a name="AtkHypertext.description"></a><h2>Description</h2>
<p>
An interface used for objects which implement linking between multiple
resource or content locations, or multiple 'markers' within a single
document.  A Hypertext instance is associated with one or more Hyperlinks,
which are associated with particular offsets within the Hypertext's included
content.  While this interface is derived from Text, there is no requirement that Hypertext instances have textual content; they may implement Image as well, and Hyperlinks need not have non-zero text offsets.
</p>
</div>
<div class="refsect1" lang="en">
<a name="AtkHypertext.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="AtkHypertext-struct"></a><h3>AtkHypertext</h3>
<pre class="programlisting">typedef struct _AtkHypertext AtkHypertext;</pre>
<p>
The AtkHypertext structure does not contain any fields.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="atk-hypertext-get-link"></a><h3>atk_hypertext_get_link ()</h3>
<pre class="programlisting"><a class="link" href="AtkHyperlink.html" title="AtkHyperlink">AtkHyperlink</a>*       atk_hypertext_get_link              (<a class="link" href="AtkHypertext.html" title="AtkHypertext">AtkHypertext</a> *hypertext,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> link_index);</pre>
<p>
Gets the link in this hypertext document at index 
<em class="parameter"><code>link_index</code></em></p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hypertext</code></em> :</span></p></td>
<td> an <a class="link" href="AtkHypertext.html" title="AtkHypertext"><span class="type">AtkHypertext</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>link_index</code></em> :</span></p></td>
<td> an integer specifying the desired link
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the link in this hypertext document at
index <em class="parameter"><code>link_index</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="atk-hypertext-get-n-links"></a><h3>atk_hypertext_get_n_links ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a>                atk_hypertext_get_n_links           (<a class="link" href="AtkHypertext.html" title="AtkHypertext">AtkHypertext</a> *hypertext);</pre>
<p>
Gets the number of links within this hypertext document.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hypertext</code></em> :</span></p></td>
<td> an <a class="link" href="AtkHypertext.html" title="AtkHypertext"><span class="type">AtkHypertext</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the number of links within this hypertext document
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="atk-hypertext-get-link-index"></a><h3>atk_hypertext_get_link_index ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a>                atk_hypertext_get_link_index        (<a class="link" href="AtkHypertext.html" title="AtkHypertext">AtkHypertext</a> *hypertext,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> char_index);</pre>
<p>
Gets the index into the array of hyperlinks that is associated with
the character specified by <em class="parameter"><code>char_index</code></em>.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hypertext</code></em> :</span></p></td>
<td> an <a class="link" href="AtkHypertext.html" title="AtkHypertext"><span class="type">AtkHypertext</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>char_index</code></em> :</span></p></td>
<td> a character index
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> an index into the array of hyperlinks in <em class="parameter"><code>hypertext</code></em>,
or -1 if there is no hyperlink associated with this character.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="AtkHypertext.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="AtkHypertext-link-selected"></a><h3>The <code class="literal">"link-selected"</code> signal</h3>
<pre class="programlisting">void                user_function                      (<a class="link" href="AtkHypertext.html" title="AtkHypertext">AtkHypertext</a> *atkhypertext,
                                                        <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a>          arg1,
                                                        <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a>      user_data)         : Run Last</pre>
<p>
The "link-selected" signal is emitted by an AtkHyperText object when one of
the hyperlinks associated with the object is selected.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>atkhypertext</code></em> :</span></p></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
<td>the index of the hyperlink which is selected

</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="AtkHypertext.see-also"></a><h2>See Also</h2>
<p>
AtkHyperlink
</p>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.10</div>
</body>
</html>
